4146 add troubleshooting section #4181
Conversation
…into 4146-add-troubleshooting-section
…into 4146-add-troubleshooting-section
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
@dhtclk LGTM, just two small things to change: 
Could we make it just a single menu item rather than a dropdown? I think the expanding tab is only necessary if we have more than one page. If we're adding here we should probably add it as an item in the top menu: 
|
…into 4146-add-troubleshooting-section
…into 4146-add-troubleshooting-section
| - [Session memory settings](/docs/operations/settings/settings) | ||
| <br/> | ||
| ### Scaling and sizing: {#scaling-and-sizing} | ||
| - [Right-size your service](/docs/operations/tips) |
There was a problem hiding this comment.
Just an idea, but some of these like this one are only really applicable to OSS ClickHouse. Maybe we should mark them with a ⛁ vs ☁️ if they are specific
|
@kellytoole I know you also said you wanted to take a look at this. There's a first draft of the "lessons learned" doc in this PR along with the troubleshooting section. |
…into 4146-add-troubleshooting-section
There was a problem hiding this comment.
Left some comments. I think it would be good to get feedback from some other members of the PM team. Let's ask @gingerwizard to give feedback on the interactive code block sections.
| description: 'Learn from the ClickHouse community with real world scenarios and lessons learned' | ||
| --- | ||
|
|
||
| # ClickHouse Community Wisdom: Tips and Tricks from Meetups {#community-wisdom} |
There was a problem hiding this comment.
| # ClickHouse Community Wisdom: Tips and Tricks from Meetups {#community-wisdom} | |
| # ClickHouse community wisdom: tips and tricks from meetups {#community-wisdom} |
We had taken to sentence casing, which is how Google does it https://developers.google.com/style/capitalization. I'm not strongly opinionated on which style we have but it will be nice to keep it consistent.
| **Conventional wisdom:** Use Redis for rate limiting. | ||
|
|
||
| **Craigslist's breakthrough:** *"Everyone uses Redis for rate limiter implementations... Why not just do it in Redis?"* | ||
|
|
||
| **The problem with Redis:** *"Our experience with Redis is not like what you've seen in the movies... weird maintenance issues... we will reboot a node in a Redis cluster and some weird latency spike hits the front end"* | ||
|
|
||
| **Test rate limiting logic using ClickHouse approach:** |
There was a problem hiding this comment.
- The bold: point format feels too obviously AI generated to me. Wonder if we couldn’t rework these to rather be paragraphs of text. This could just be me though, let's get feedback from others on that.
Also feel that if we're referencing specific companies and quoting from the videos we should probably link to the meetup videos.
|
|
||
| **Success pattern:** ClickHouse's speed enables customer-facing applications with sub-second response times, challenging the notion that analytical databases are only for internal use. | ||
|
|
||
| ### The Rule-Breaking Philosophy {#rule-breaking-philosophy} |
There was a problem hiding this comment.
Should this be H3 as a sub point of "Customer-Facing Real-Time Applications"?
|
|
||
| ## Focus on Individual Queries, Not Averages {#focus-on-individual-queries-not-averages} | ||
|
|
||
| **Alexey Milovidov's core insight:** *"The right way is to ask yourself why this particular query was processed in five seconds... I don't care if median and other queries process quickly I only care about my query"* |
There was a problem hiding this comment.
| **Alexey Milovidov's core insight:** *"The right way is to ask yourself why this particular query was processed in five seconds... I don't care if median and other queries process quickly I only care about my query"* | |
| **Alexey Milovidov's core insight:** *"The right way is to ask yourself why this particular query was processed in five seconds... I don't care if median and other queries process quickly I only care about my query"* |
Nit: we should be consistent throughout if we mention the speaker or not
|
Some feedback around the code block:
|
Co-authored-by: Shaun Struwig <[email protected]>
Co-authored-by: Shaun Struwig <[email protected]>
Co-authored-by: Shaun Struwig <[email protected]>
Co-authored-by: Shaun Struwig <[email protected]>
Co-authored-by: Shaun Struwig <[email protected]>
Co-authored-by: Shaun Struwig <[email protected]>
…into 4146-add-troubleshooting-section
Summary
Adding a troubleshooting page to create a space for useful links based on support data. Hopefully boosting discoverability of some existing quality docs and kb articles.